/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file
 * Definitions of warnings for use of various insecure functions
 */

#ifndef _RTE_WARNINGS_H_
#define _RTE_WARNINGS_H_

#ifdef RTE_INSECURE_FUNCTION_WARNING

/* we need to include all used standard header files so that they appear
 * _before_ we poison the function names.
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <errno.h>
#ifdef RTE_LIBRTE_EAL_LINUXAPP
#include <dirent.h>
#endif

/* rte_snprintf uses snprintf, so include its definition before we poison the
 * functions, otherwise we'll get an error in it. */
#include <rte_string_fns.h>

/* the following function are deemed not fully secure for use e.g. they
 * do not always null-terminate arguments */
#pragma GCC poison sprintf strtok snprintf vsnprintf
#pragma GCC poison strlen strcpy strcat
#pragma GCC poison sscanf

/* other unsafe functions may be implemented as macros so just undef them */
#ifdef strsep
#undef strsep
#else
#pragma GCC poison strsep
#endif

#ifdef strncpy
#undef strncpy
#else
#pragma GCC poison strncpy
#endif

#ifdef strncat
#undef strncat
#else
#pragma GCC poison strncat
#endif

#endif

#endif /* RTE_WARNINGS_H */
